-
Notifications
You must be signed in to change notification settings - Fork 15
Add pipeline for docs using GitHub Pages #73
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is great! Thank you!
I think we only care about the latest documentation?
Is there a way to test this before we merge the PR? Otherwise, we can always tweak after merging.
0a2c337
to
739ecbc
Compare
@esabol, I've tested it on my fork by removing |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good! Thank you!
So what's the URL of the GitHub Pages documentation? We should add this URL to the README and possibly the documentation itself, I think. And the "About" box on the front page of the repository. I tried https://postgrespro.github.io/pgsphere/ and got a 404 error, so that must not be it? |
@esabol, @borodun It should be https://postgrespro.github.io/pgsphere/ . It worked yesterday before the last merge. But it displays 404 now unfortunately. We will check and fix it. It may be the result of the changes in the master branch (changed version number). Thank you for reporting! |
@esabol, @vitcpp It looks like the following job https://github.com/postgrespro/pgsphere/actions/runs/6403043991 (default Jekyll workflow) was executed after https://github.com/postgrespro/pgsphere/actions/runs/6403044188 and erased all static files. After re-run, docs appeared again on https://postgrespro.github.io/pgsphere/. We need to disable this workflow: https://github.com/postgrespro/pgsphere/actions/workflows/pages/pages-build-deployment. Seems like it was added due to mistake in repo setting, because it doesn't have a corresponding workflow file in |
I was reading the documentation on this yesterday, and it said something about creating a |
@esabol, thank you! As I understand from the docs, this file is only used when publishing Github Pages from a branch. We have tried to change repo settings to use Github Actions to publish Pages. We will see if this helped when new commits will be added to master. So, for now, this file won't be necessary, I think. |
Build and deploy docs to GitHub Pages. This workflow will deploy for master branch. For now, it hosts doc/html directory, so only the last version will be available. How necessary is it to organize the deployment of documentation with previous versions?